#region (c) 2014 THN Solutions LLC. - All rights reserved
/*
Simplified BSD License (BSD)
Copyright (c) 2014, THN Solutions LLC. ( www.ThnSolutions.com )
Author: Nguyễn, M. Hải                 ( www.Minh-Hai.com     )
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice, this 
      list of conditions and the following disclaimer.

    * Redistributions in binary form must reproduce the above copyright notice, 
      this list of conditions and the following disclaimer in the documentation 
      and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.
*/
#endregion

#region Record of Change
//             							CHANGE HISTORY
// -------------------------------------------------------------------------------------
// |   DATE    | DEVELOPER  | DESCRIPTION                                              |
// -------------------------------------------------------------------------------------
// | 14-Nov-09 | HaiNM      | First creation.                                          |
// -------------------------------------------------------------------------------------
//
#endregion

#region Record of Audit
//             							REVIEW HISTORY
// -------------------------------------------------------------------------------------
// |   DATE    | REVIEWER   | NOTES                                                    |
// -------------------------------------------------------------------------------------
// -------------------------------------------------------------------------------------
//
#endregion

#region Using directives
using System;
using System.Collections;

using Thn;
#endregion

namespace Thn.Interface.Vcl
{
    /// <summary>
    /// A page history is responsible for keeping track of page navigation history. It works similar to a stack.
    /// </summary>
#if DEBUG
    public
#else
    public
#endif
    interface IPageHistory
    {
        /// <summary>
        /// Gets the number of items contained.
        /// </summary>
        int Count
        { get; }

        /// <summary>
        /// Gets an item at the specified location index.
        /// </summary>
        /// <param name="index">Zero-based location index.</param>
        IPageDescriptor this[int index]
        { get; }

        /// <summary>
        /// Gets the item on top of the stack.
        /// </summary>
        IPageDescriptor Current
        { get; }

        /// <summary>
        /// Push an item on the history stack.
        /// </summary>
        void Push(IPageDescriptor item);

        /// <summary>
        /// Remove the top item off the stack.
        /// </summary>
        IPageDescriptor Pop();

        /// <summary>
        /// Gets/Sets the maximum number of items to keep track of.
        /// <para>When pushing more item over this limit, the ones under the bottom will be removed.</para>
        /// </summary>
        int Capacity
        { get; set; }

        /// <summary>
        /// Empty this stack.
        /// </summary>
        void Clear();
    }
}
